Skip to content

Conversation

@st0012
Copy link
Member

@st0012 st0012 commented Oct 12, 2025

This theme's "backend" (Ruby part) is mostly based on Darkfish. But design and frontend features is (IMO) a lot better than it.

The work was assisted by AI coding tools through a few weeks. I cleaned up the history because they're not helping reviewing anyway.

(Aliki is the name of my cat, which was not involved in this work)

Key features

  • 3 column design (which matches most API docs nowadays)
  • Switchable dark mode
  • Right ToC column
  • Better search UI
  • Slightly better mobile design
  • Code pasting support

Future work

  • Configurable top navbar items (at least link to GH and gem?)
  • Configurable footer (same as the above?)
  • Social media preview image support (it's not possible have nice static preview cards without an image)
  • ???

Preview

Link in #1432 (comment)

@matzbot
Copy link
Collaborator

matzbot commented Oct 12, 2025

🚀 Preview deployment available at: https://65458a14.rdoc-6cd.pages.dev (commit: bc8c40e)

@st0012 st0012 force-pushed the aliki branch 6 times, most recently from 895f159 to 5771f3e Compare October 31, 2025 14:11
@st0012 st0012 marked this pull request as ready for review October 31, 2025 14:19
Co-authored-by: taea <[email protected]>
@hsbt
Copy link
Member

hsbt commented Nov 10, 2025

I prefer Aliki theme. I'm +1 to make this theme as default.

@colby-swandale
Copy link
Member

Same!

@kou
Copy link
Member

kou commented Nov 10, 2025

+1

@mame
Copy link
Member

mame commented Nov 11, 2025

Does this URL stay the same? If existing links, including fragments, continue to work well, it looks good 👍

@st0012
Copy link
Member Author

st0012 commented Nov 11, 2025

@mame Thanks. And yes, the theme should not change any RDoc behaviour other than the visuals.

@nobu
Copy link
Member

nobu commented Nov 13, 2025

I think it's better to make the blue letters in dark mode a little brighter.
In general, less contrast combination does not look good.

Copy link
Member

@tompng tompng left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

9 participants